Skip to content

docs: add missing autodoc for click and aiohttp-server #3060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Dec 3, 2024
Merged

docs: add missing autodoc for click and aiohttp-server #3060

merged 4 commits into from
Dec 3, 2024

Conversation

@emdneto
Copy link
Member

@emdneto emdneto commented Dec 2, 2024

Description

Add missing docs for opentelemetry-instrumentation-click and opentelemetry-instrumentation-aiohttp-server

@github-actions github-actions bot requested a review from nemoshlag December 2, 2024 21:10
@emdneto
fix click readme
09bf12f 
Signed-off-by: emdneto <[email protected]>
@emdneto emdneto added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Dec 2, 2024
@emdneto
add nitpick
bb95aff 
Signed-off-by: emdneto <[email protected]>
@emdneto emdneto marked this pull request as ready for review December 2, 2024 23:05
@emdneto emdneto requested a review from a team as a code owner December 2, 2024 23:05
emdneto
emdneto commented Dec 2, 2024
View reviewed changes
Copy link
Member Author

@emdneto emdneto left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it would be nice to have a CI job to check if we have docs for all available instrumentation

emdneto
emdneto commented Dec 2, 2024
View reviewed changes
Copy link
Member Author

@emdneto emdneto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some documentations are broken with wrong rst blocks, specially related to kafka

@emdneto emdneto mentioned this pull request Dec 2, 2024
Open
xrmx
xrmx approved these changes Dec 3, 2024
View reviewed changes
Copy link
Contributor

@xrmx xrmx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, will need to update CONTRIBUTING.md with this

@xrmx xrmx enabled auto-merge (squash) December 3, 2024 09:10
@xrmx xrmx merged commit 668cb75 into open-telemetry:main Dec 3, 2024
573 checks passed
@emdneto emdneto mentioned this pull request Dec 3, 2024
Open
@xrmx xrmx mentioned this pull request Dec 3, 2024
Merged
11 tasks
xrmx added a commit to xrmx/opentelemetry-python-contrib that referenced this pull request Jan 24, 2025
@emdneto @xrmx
docs: add missing autodoc for click and aiohttp-server (open-telemetr…
510f596 
…y#3060)

* add missing docs for click and aiohttp-server

Signed-off-by: emdneto <[email protected]>

* fix click readme

Signed-off-by: emdneto <[email protected]>

* add nitpick

Signed-off-by: emdneto <[email protected]>

---------

Signed-off-by: emdneto <[email protected]>
Co-authored-by: Riccardo Magliocchetti <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@xrmx xrmx xrmx approved these changes

@tammy-baylis-swi tammy-baylis-swi tammy-baylis-swi approved these changes

@nemoshlag nemoshlag Awaiting requested review from nemoshlag

Assignees

@nemoshlag nemoshlag

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@emdneto @xrmx @tammy-baylis-swi @nemoshlag